org.eclipse.vtp.framework.interactions.core.configurations
Class DataRequestConfiguration

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.configurations.DataRequestConfiguration

All Implemented Interfaces:

IConfiguration, InteractionsConstants

public class DataRequestConfiguration
extends java.lang.Object
implements IConfiguration, InteractionsConstants

Configuration for an data request interaction.

Author:

Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.interactions.core.configurations.InteractionsConstants

NAME_CHOICE, NAME_CHOICES, NAME_CONTENT_TYPE, NAME_DATA_NAME, NAME_DATA_REQUEST, NAME_FORMATTER, NAME_ID, NAME_INPUT, NAME_INPUT_ITEM, NAME_INPUT_NAME, NAME_INPUT_REQUEST, NAME_INTERACTION_TYPE, NAME_KEY, NAME_LANGUAGE, NAME_LOCALE, NAME_MEDIA, NAME_MEDIA_PROVIDER, NAME_MEDIA_PROVIDER_BINDING, NAME_META_DATA, NAME_META_DATA_ITEM, NAME_META_DATA_SET, NAME_NAME, NAME_OUTPUT, NAME_OUTPUT_ITEM, NAME_OUTPUT_MESSAGE, NAME_OUTPUT_NAME, NAME_PROPERTY, NAME_PROPERTY_ITEM, NAME_RESOURCE_MANAGER, NAME_SCRIPT, NAME_SCRIPTING_LANGUGAGE, NAME_SELECTION_REQUEST, NAME_SHARED_CONTENT, NAME_TRANSFER_MESSAGE, NAME_TYPE, NAME_VALUE, NAMESPACE_URI

Constructor Summary

DataRequestConfiguration(IContentFactory contentFactory)
Creates a new DataRequestConfiguration.

Method Summary

java.lang.String	getDataName() Returns the name of the data collected by this request.
MediaConfiguration	getMediaConfiguration() Returns the media configuration for this message or null if no such configuration is registered.
java.lang.String	getOutputName() Returns the name of the output item to play.
void	load(org.w3c.dom.Element configurationElement) Loads the configuration information from the specified XML element.
void	save(org.w3c.dom.Element configurationElement) Saves the configuration information into the supplied XML element.
void	setDataName(java.lang.String dataName) Sets the name of the data collected by this request.
void	setMediaConfiguration(MediaConfiguration mediaConfiguration) Sets the media configuration for this message.
void	setOutputName(java.lang.String outputName) Sets the name of the output item to play.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataRequestConfiguration

public DataRequestConfiguration(IContentFactory contentFactory)

Creates a new DataRequestConfiguration.

Parameters:

contentFactory - The content factory to use.

Method Detail

getOutputName

public java.lang.String getOutputName()

Returns the name of the output item to play.

Returns:

The name of the output item to play.

setOutputName

public void setOutputName(java.lang.String outputName)

Sets the name of the output item to play.

Parameters:

outputName - The name of the output item to play.

getDataName

public java.lang.String getDataName()

Returns the name of the data collected by this request.

Returns:

The name of the data collected by this request.

setDataName

public void setDataName(java.lang.String dataName)

Sets the name of the data collected by this request.

Parameters:

dataName - The name of the data collected by this request.

getMediaConfiguration

public MediaConfiguration getMediaConfiguration()

Returns the media configuration for this message or null if no such configuration is registered.

Returns:

The media configuration for this message or null if no such configuration is registered.

setMediaConfiguration

public void setMediaConfiguration(MediaConfiguration mediaConfiguration)

Sets the media configuration for this message.

Parameters:

mediaConfiguration - The media configuration for this message or null to remove the configuration.

load

public void load(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Loads the configuration information from the specified XML element.

Specified by:

load in interface IConfiguration

Parameters:

configurationElement - The element to load the configuration from.

save

public void save(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Saves the configuration information into the supplied XML element.

Specified by:

save in interface IConfiguration

Parameters:

configurationElement - The element to save the configuration to.